package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.EmpInfoUpdateDTO;
import org.jsola.hr.dto.NameVerifiedAddDTO;
import org.jsola.hr.dto.NameVerifiedUpdateDTO;
import org.jsola.hr.query.NameVerifiedQuery;
import org.jsola.hr.vo.NameVerifiedListVO;
import org.jsola.hr.vo.NameVerifiedVO;

import java.util.List;

/**
 * 实名认证
 *
 * @author zhr
 */
@Api(tags = "hr-实名认证")
public interface INameVerifiedControllerAPI {

    /**
     * 新增实名认证
     * @param nameVerifiedAddDTO 实名认证新增实体
     * @return 实名认证展示对象
     */
    @ApiOperation(value = "新增实名认证")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "nameVerifiedAddDTO", dataType = "NameVerifiedAddDTO", value = "新增实名认证", paramType = "body")
    })
    Result<NameVerifiedVO> save(NameVerifiedAddDTO nameVerifiedAddDTO);


    /**
     * 修改实名认证
     * @param nameVerifiedUpdateDTO 实名认证
     * @return 更新数量
     */
    @ApiOperation(value = "修改实名认证")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "nameVerifiedUpdateDTO", dataType = "NameVerifiedUpdateDTO", value = "修改实名认证", paramType = "body")
    })
    Result<Integer> update(NameVerifiedUpdateDTO nameVerifiedUpdateDTO);




    /**
     * 删除单个实名认证，彻底删除
     * @param nameVerifiedId 实名认证id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个实名认证，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "nameVerifiedId", dataType = "Long", value = "实名认证id", paramType = "path")
    })
    Result<Integer> delete(Long nameVerifiedId);


    /**
     * 批量删除实名认证，彻底删除
     * @param nameVerifiedIds 实名认证id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除实名认证，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "nameVerifiedIds", dataType = "Long[]", value = "实名认证id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] nameVerifiedIds);


    /**
     * 根据实名认证id查询实名认证详情
     * @param nameVerifiedId 实名认证id
     * @return 实名认证详情
     */
    @ApiOperation(value="根据实名认证id查询实名认证详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "nameVerifiedId", dataType = "Long", value = "实名认证id", paramType = "path")
    })
    Result<NameVerifiedVO> findById(Long nameVerifiedId);


    /**
     * 查询实名认证
     * @param nameVerifiedQuery 实名认证查询参数
     * @return page
     */
    @ApiOperation(value="查询实名认证")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "nameVerifiedQuery", dataType = "NameVerifiedQuery", value = "实名认证查询参数", paramType = "query")
    })
    Result<List<NameVerifiedListVO>> listAll(NameVerifiedQuery nameVerifiedQuery);


     /**
     * 分页查询实名认证
     * @param nameVerifiedQuery 实名认证查询参数
     * @return page
     */
    @ApiOperation(value="分页查询实名认证")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "nameVerifiedQuery", dataType = "NameVerifiedQuery", value = "实名认证查询参数", paramType = "query")
    })
    Result<Page<NameVerifiedListVO>> page(NameVerifiedQuery nameVerifiedQuery);


}

